\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket}{\section{\-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket \-Class \-Reference}
\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket}\index{\-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket@{\-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket}}
}


\-Data \-Holder for \hyperlink{namespaceS3}{\-S3} bucket.  


\-Inheritance diagram for \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classRestAPI_1_1amazon_1_1S3_1_1Bucket}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aa4145b09df0e067c225f07dd7b2ab963}{def {\bfseries \-\_\-\-\_\-init\-\_\-\-\_\-}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aa4145b09df0e067c225f07dd7b2ab963}

\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a430af1e47f2a70ec1c376cc0b2a609e8}{add\-Remote}
\begin{DoxyCompactList}\small\item\em \-Add a bucket to remote server. \end{DoxyCompactList}\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a922a3621e5e4b15233172212cee1c66a}{ls}
\begin{DoxyCompactList}\small\item\em \-The generator to list the content inside the bucket. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a7667e36a55e90bb91362b348ed402e3c}{def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a7667e36a55e90bb91362b348ed402e3c}{delete}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a7667e36a55e90bb91362b348ed402e3c}

\begin{DoxyCompactList}\small\item\em \-Delete the files in the file list. \end{DoxyCompactList}\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a2cdca6cb14122be29c66f41ffe9d25af}{create\-Upload\-Form}
\begin{DoxyCompactList}\small\item\em \-Create a upload form to upload into a bucket. \end{DoxyCompactList}\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_afd44494eae8e0ebc5a6525ff833c1f59}{has}
\begin{DoxyCompactList}\small\item\em \-Check if the file obj or file exists remotely on \hyperlink{namespaceS3}{\-S3}. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a3d94dc441d01334297cab6644a4501ed}{def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a3d94dc441d01334297cab6644a4501ed}{\-\_\-\-\_\-eq\-\_\-\-\_\-}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a3d94dc441d01334297cab6644a4501ed}

\begin{DoxyCompactList}\small\item\em \-Check if bucket1 == bucket2. \end{DoxyCompactList}\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a589fb49ffd46b450ee95a7408f65b05d}{get}
\begin{DoxyCompactList}\small\item\em \-Create a \-File object and download its content from the specified path of the bucket. \end{DoxyCompactList}\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aaf0e07aabe7a436f31874b14e0b9489c}{add}
\begin{DoxyCompactList}\small\item\em \-Create a \-File object and upload its content(from source) to the specified path of the bucket. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_ad8e45dd3b7aec6ed0809268b5a8b866f}{def {\bfseries \-\_\-\-\_\-getitem\-\_\-\-\_\-}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_ad8e45dd3b7aec6ed0809268b5a8b866f}

\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aa58c1ce990cc60c864511c55a22e3d1b}{get\-Policy}
\begin{DoxyCompactList}\small\item\em \-Get the bucket access policy. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aeba39bc27d401a3a24c60938003092bb}{def {\bfseries update\-Policy}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aeba39bc27d401a3a24c60938003092bb}

\item 
def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a83ce0c1ea16eb0b89d06104a25a0d772}{add\-Temporary\-Folder}
\begin{DoxyCompactList}\small\item\em \-Add a folder that have life cyle. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a3a089c2b25063d93ddc4bf3619b9a2bc}{def {\bfseries list\-Temporary\-Folders}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a3a089c2b25063d93ddc4bf3619b9a2bc}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aefb7c737574fe8c15e8d50599ed67786}{def {\bfseries delete\-Temporary\-Folders}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aefb7c737574fe8c15e8d50599ed67786}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a82e773d50ba56b2c6205403ccf825dcb}{def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a82e773d50ba56b2c6205403ccf825dcb}{payby}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a82e773d50ba56b2c6205403ccf825dcb}

\begin{DoxyCompactList}\small\item\em \-Payment policy. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_ac597b88a178c950a4436e1a457af725a}{def \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1Bucket_ac597b88a178c950a4436e1a457af725a}{create\-File\-Object}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_ac597b88a178c950a4436e1a457af725a}

\begin{DoxyCompactList}\small\item\em \-Create a \-File object in memory. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a005bfd3657593c89f8ec07cecc2f4670}{def {\bfseries get\-A\-C\-L}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a005bfd3657593c89f8ec07cecc2f4670}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a7b07cb746e320d38c19ef4212deab9de}{def {\bfseries create\-A\-C\-L}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a7b07cb746e320d38c19ef4212deab9de}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a8b04bae80cda7be04f6625ed303f9e69}{def {\bfseries update\-A\-C\-L}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a8b04bae80cda7be04f6625ed303f9e69}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a533c0ddf04d3fcbac3224ba0af631543}{def {\bfseries get\-Life\-Cycle\-Rules}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a533c0ddf04d3fcbac3224ba0af631543}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aadf736144cc01342c2843d7720ea4a53}{def {\bfseries update\-Life\-Cycle\-Rules}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aadf736144cc01342c2843d7720ea4a53}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a9376f098392c8240607fee3870c89d97}{def {\bfseries get\-Version\-Control}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a9376f098392c8240607fee3870c89d97}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a905d0acaca983740074da7c8b0704844}{def {\bfseries update\-Version\-Control}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a905d0acaca983740074da7c8b0704844}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a5f315411ab9dbc513a5c377b1ed285e0}{def \hyperlink{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a5f315411ab9dbc513a5c377b1ed285e0}{set\-Owner}}\label{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a5f315411ab9dbc513a5c377b1ed285e0}

\begin{DoxyCompactList}\small\item\em \-Set the owner of the \-A\-W\-S service. \end{DoxyCompactList}\item 
\hypertarget{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a360415be2c893aeedf1aad20ae5b71ad}{def \hyperlink{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a360415be2c893aeedf1aad20ae5b71ad}{set\-Credential}}\label{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a360415be2c893aeedf1aad20ae5b71ad}

\begin{DoxyCompactList}\small\item\em \-Set the credential information of the current bucket. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{\-Public \-Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aadaf7b380c7017dd8104874556dc132f}{{\bfseries name}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aadaf7b380c7017dd8104874556dc132f}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a0c54f50973f027e57d86f672d469f65b}{{\bfseries host}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a0c54f50973f027e57d86f672d469f65b}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aeb413cc79ef09644244b68a161baa661}{{\bfseries objects}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aeb413cc79ef09644244b68a161baa661}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_abbe39d5f71d640ae8ad1ebf84915623f}{{\bfseries owner}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_abbe39d5f71d640ae8ad1ebf84915623f}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1service_1_1AWSservice_aefa6630feb9c838da6d037e3c816f24b}{{\bfseries \-Auth\-Key}}\label{classRestAPI_1_1amazon_1_1service_1_1AWSservice_aefa6630feb9c838da6d037e3c816f24b}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a2b5c174ee99f2a1d928380c642a374e0}{{\bfseries \-Secret\-Access\-Key}}\label{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a2b5c174ee99f2a1d928380c642a374e0}

\item 
\hypertarget{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a2337cd37c96df6f85389dfe4e86b6e8f}{{\bfseries security\-Token}}\label{classRestAPI_1_1amazon_1_1service_1_1AWSservice_a2337cd37c96df6f85389dfe4e86b6e8f}

\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-Data \-Holder for \hyperlink{namespaceS3}{\-S3} bucket. 

\subsection{\-Member \-Function \-Documentation}
\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aaf0e07aabe7a436f31874b14e0b9489c}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!add@{add}}
\index{add@{add}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{add}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-add} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{dest\-Path, }
\item[{}]{source}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aaf0e07aabe7a436f31874b14e0b9489c}


\-Create a \-File object and upload its content(from source) to the specified path of the bucket. 

\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a430af1e47f2a70ec1c376cc0b2a609e8}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!add\-Remote@{add\-Remote}}
\index{add\-Remote@{add\-Remote}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{add\-Remote}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-add\-Remote} (
\begin{DoxyParamCaption}
\item[{}]{self}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a430af1e47f2a70ec1c376cc0b2a609e8}


\-Add a bucket to remote server. 

\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a83ce0c1ea16eb0b89d06104a25a0d772}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!add\-Temporary\-Folder@{add\-Temporary\-Folder}}
\index{add\-Temporary\-Folder@{add\-Temporary\-Folder}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{add\-Temporary\-Folder}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-add\-Temporary\-Folder} (
\begin{DoxyParamCaption}
\item[{}]{self}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a83ce0c1ea16eb0b89d06104a25a0d772}


\-Add a folder that have life cyle. 

\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a2cdca6cb14122be29c66f41ffe9d25af}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!create\-Upload\-Form@{create\-Upload\-Form}}
\index{create\-Upload\-Form@{create\-Upload\-Form}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{create\-Upload\-Form}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-create\-Upload\-Form} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{policy, }
\item[{}]{dest\-Path = {\ttfamily '/'}}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a2cdca6cb14122be29c66f41ffe9d25af}


\-Create a upload form to upload into a bucket. 

\-Upload \-Path and policy must be provided. \hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a589fb49ffd46b450ee95a7408f65b05d}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!get@{get}}
\index{get@{get}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{get}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-get} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{dest\-Path}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a589fb49ffd46b450ee95a7408f65b05d}


\-Create a \-File object and download its content from the specified path of the bucket. 

\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aa58c1ce990cc60c864511c55a22e3d1b}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!get\-Policy@{get\-Policy}}
\index{get\-Policy@{get\-Policy}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{get\-Policy}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-get\-Policy} (
\begin{DoxyParamCaption}
\item[{}]{self}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_aa58c1ce990cc60c864511c55a22e3d1b}


\-Get the bucket access policy. 

\hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_afd44494eae8e0ebc5a6525ff833c1f59}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!has@{has}}
\index{has@{has}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-has} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{fileobj}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_afd44494eae8e0ebc5a6525ff833c1f59}


\-Check if the file obj or file exists remotely on \hyperlink{namespaceS3}{\-S3}. 

\-The parameter can be a \hyperlink{classRestAPI_1_1amazon_1_1S3_1_1FileObject}{\-File\-Object} or the file name string. \hypertarget{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a922a3621e5e4b15233172212cee1c66a}{\index{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}!ls@{ls}}
\index{ls@{ls}!RestAPI::amazon::S3::Bucket@{\-Rest\-A\-P\-I\-::amazon\-::\-S3\-::\-Bucket}}
\subsubsection[{ls}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf \-Rest\-A\-P\-I.\-amazon.\-S3.\-Bucket.\-ls} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{path = {\ttfamily '/'}, }
\item[{}]{page\-Size = {\ttfamily 1000}, }
\item[{}]{get\-Version\-Info = {\ttfamily \-True}}
\end{DoxyParamCaption}
)}}\label{classRestAPI_1_1amazon_1_1S3_1_1Bucket_a922a3621e5e4b15233172212cee1c66a}


\-The generator to list the content inside the bucket. 

\-You can create the generator by\-: list\-Action=self.\-bucket.\-ls() \-Then iterate over it\-: for page in list\-Action\-: for item in page\-: print item \-You can limit the page\-Size, or path \-You can also prevent getting version information(get\-Version\-Info=\-False) if the bucket is not version controlled. 

\-The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
amazon/\-S3.\-py\end{DoxyCompactItemize}
